/*
 * Robust Pointers - A framework for robust pointers in a MT environment.
 * http://code.google.com/p/rptr/
 *
 * Copyright (c) 2009, Bill K. Barekas <bbarekas@gmail.com>
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *    1. Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *    2. Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *    3. Neither the name of the author nor the names of its
 *       contributors may be used to endorse or promote products derived
 *       from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

/**
 * @file    rptr_macros.h
 * @author  Bill K. Barekas <bbarekas@gmail.com>
 * @date    October 4, 2009
 * @version $Id$
 *
 * This file contains several macros used in the Robust PoinTeR library.
 */


#ifndef RPTR_MACROS_H_
#define RPTR_MACROS_H_


#include <stdlib.h>
#include <stdarg.h>
#include <string.h>


#ifdef __cplusplus
extern "C"
{
#endif


/* SET_VALUE macro to initialize memory with some value. */
#define SET_VALUE(ptr, val)                                         \
  if ((ptr)) {                                                      \
    memset((ptr), (val), sizeof(*#ptr));                            \
  }


/* SAFE_FREE macro to release an allocated pointer and the nullify it. */
#define SAFE_FREE(ptr)                                              \
  if ((ptr)) {                                                      \
    free((ptr));                                                    \
    (ptr) = NULL;                                                   \
  }


/* CHECK_LOCKED macro to check the status of a given mutex. */
#define CHECK_LOCKED(mtx)                                            \
  ((EBUSY == pthread_mutex_trylock((mtx))) ? 0 : 1)


#ifdef __cplusplus
}
#endif


#endif /* RPTR_MACROS_H_ */
